• *add_days Function
• *add_hours Function
• *add_minutes Function
• *add_months Function
• *add_seconds Function
• *add_years Function
• *days_between Function
• *hours_between Function
• *minutes_between Function
• *months_between Function
• *seconds_between Function
• *years_between Function
• a5_add_timestamp Function
• A5_CONVERT_DATE_STRING Function
• A5_CONVERT_DATETIME_STRING Function
• a5_embeddedcalendargenie Function
• a5_get_date_format Function
• A5_GETDATEHTML Function
• a5_gettimeformats Function
• a5_gettimevalue Function
• a5_normalizedate Function
• A5_RFC1123DATE Function
• A5_RFC822DATE Function
• A5_RFC850DATE Function
• A5_T_FROM_RFCDATE Function
• a5_time_format_help Function
• A5_TIMESTAMP Function
• ADD_BUS_DAYS Function
• ADDMONTHS Function
• ADDYEARS Function
• AGE Function
• BUS_DAYS_BETWEEN Function
• CDATE Function
• CDOW Function
• CMONTH Function
• CONVERT_TYPE Function
• CShortTime Function
• CTIME Function
• CTOD Function
• CTODT Function
• CTOT Function
• CYEAR Function
• Date and Time Conversion Matrix
• Date and Time Format Elements
• Date and Time Functions
• DATE Function
• Date_FirstDayOfMonth Function
• Date_FirstDayOfPreviousMonth Function
• DATE_FORMAT Function
• DATE_FORMATS_BUILT_IN Function
• date_from_utc_date Function
• date_is_anniversary Function
• date_is_in_last_month Function
• DATE_IS_IN_MONTH Function
• date_is_in_previous_quarter Function
• date_is_in_previous_week Function
• date_is_in_previous_year Function
• date_is_in_same_week Function
• date_is_in_this_month Function
• date_is_in_this_month_todate Function
• date_is_in_this_quarter Function
• date_is_in_this_quarter_todate Function
• date_is_in_this_week Function
• date_is_in_this_week_todate Function
• date_is_in_this_year Function
• date_is_in_this_year_todate Function
• date_is_today Function
• date_is_yesterday Function
• Date_LastDayOfMonth Function
• Date_LastDayOfPreviousMonth Function
• date_quarternumber Function
• date_quarterstartend Function
• date_to_utc_date Function
• DATE_VALUE Function
• DAY Function
• DAY_NUMBER Function
• DMY Function
• DOW Function
• DOW_ISO Function
• DTOC Function
• DTOS Function
• FixDateString Function
• FORMAT_DATA Function
• GetTimeZoneOffset Function
• GMT Function
• Holidays
• httpdate Function
• international_days_of_week Function
• international_months Function
• JDATE Function
• JTODATE Function
• MDY Function
• MONTH Function
• MONTH_END Function
• MONTH_NUMBER Function
• MONTH_START Function
• NOW Function
• NTH_DOW Function
• ODBC_DT_TO_D Function
• Predefined Date Formats
• ProgressTimed Function
• SCANTIME Function
• ShortTime_Extract Function
• STOD Function
• Time and Date Functions
• TIME Function
• time_gmt_to_local Function
• time_to_unixtimestamp Function
• TIME_VAR Function
• timez Function
• TOSECONDS Function
• TOTIME Function
• TZ_OFFSET_TO_C Function
• unixtimestamp_to_time Function
• WEEK Function
• WEEK_ISO Function
• WEEK_ISO_FULL Function
• WIN_TIME Function
• WMI_DATE_TO_TIME Function
• wmi_datetime_to_time Function
• YEAR Function
• YearStart_ISO Function

 

FORMAT_DATA Function

Syntax

Arguments

input_valueCharacter Date Logical Numeric

The value to format.

format_codeCharacter

A format string. Refer to Display Formats.

fld_widthNumeric

Default = 20. The maximum expected length of the formatted string. Value must be larger than the length of the formatted string. For numeric values only.

fld_decNumeric

Default = 2. The number of characters after the decimal point. Output will be padded with zeros. For numeric values only.

Description

Formats an input string using a format_code. Returns a character string.

Discussion

The FORMAT_DATA() function formats a character, date, numeric, or logical value. For numeric inputs, FORMAT_DATA() is the same as calling ALLTRIM(STR(...)).

? format_data("edwaRd","Z")
= "Edward"

? format_data(date(),"3C")
= "16 MARCH 2017"

? format_data(.t.,"2")
= "Yes"

? format_data(1234567.89,",B*")
= "********1,234,567.89"

dim nn as N
nn = 12345678900000.456
? format_data(nn,"$",22)
= "$12,345,678,900,000.46"

See Also

• Character Formatting Functions
• Predefined Display Formats
• Date and Time Functions